{-
	Copyright (c) 2009 Aitor Lopez Fadrique <mailto:aitorlf@gmail.com>
	All rights reserved
	Licensed under GNU LGPL v2.1

	$Id: CuajoDeck.hs 15 2009-09-28 21:16:23Z aitorlf $

	This program is free software; you can redistribute it and/or
	modify it under the terms of the GNU Lesser General Public
	License version 2.1 (and just under that one) as published by
	the Free Software Foundation.

	This program is distributed in the hope that it will be useful,
	but without any warranty; without even the implied warranty of
	merchantability or fitness for a particular purpose. See the GNU
	Lesser General Public License for more details.

	You should have received a copy of the GNU Lesser General Public
	License along with this program; if not, write to the Free
	Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
	MA 02111-1307, USA.
-}

{-|
	Module		: Games.Cards.Deck.CuajoDeck
	Copyright	: (c) Aitor Lopez Fadrique <mailto:aitorlf@gmail.com>
	License		: GNU LGPL v2.1 <http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html>

	Maintainer	: Aitor Lopez Fadrique <mailto:aitorlf@gmail.com>
	Stability	: provisional
	Portability	: portable

	Definition of the Cuajo decks according to Games.Cards.Deck.

	This module defines the basic Cuajo 28 cards deck together with the quadruple-sized deck.
-}
module Games.Cards.Deck.CuajoDeck(
		-- * Cuajo deck
		-- ** Types defining cards and decks for the Cuajo deck
		CuajoRank(..),
		LatinSuit(..),
		CuajoCard,
		CuajoDeck,
		-- ** Instance of Cuajo deck
		cuajoSingleDeck,
		cuajoQuadrupleDeck,
		cuajoDeck,
	)where

import Games.Cards.Deck
import Games.Cards.Deck.ItalianClassicDeck


-- | Well-known ranks for the Cuajo deck.
data CuajoRank =
		-- | 'Ace'
		Ace
		-- | 'Three' (/3/)
		| Three
		-- | 'Four' (/4/)
		| Four
		-- | 'Five' (/5/)
		| Five
		-- | 'Knave'
		| Knave
		-- | 'Knight'
		| Knight
		-- | 'King'
		| King
	deriving (Eq, Ord, Enum, Bounded, Show, Read)
instance CardRank CuajoRank


-- | Definition of the 36 cards Cuajo @'Card'@s and @'Deck'@s.

-- | Cuajo card type.
type CuajoCard = Card CuajoRank LatinSuit WildCardNone

-- | Cuajo deck type.
type CuajoDeck = Deck CuajoRank LatinSuit WildCardNone

-- | Ceki single deck instance.
cuajoSingleDeck :: CuajoDeck
cuajoSingleDeck = deck

-- | Ceki double deck instance.
cuajoQuadrupleDeck :: CuajoDeck
cuajoQuadrupleDeck = multipleDecks 4

-- | Cuajo deck instance.
cuajoDeck :: CuajoDeck
cuajoDeck = cuajoQuadrupleDeck
